API Server Commands¶

start-api-service¶

Execute the start-api-service command to start or resume the applications inside the API service container.

Example:

start-api-service

stop-api-service¶

Execute the stop-api-service command to stop the applications inside the API service container.

Example:

stop-api-service

start-dc-service¶

Execute the start-dc-service command to start or resume the containers inside Director Console. You can execute the command with the following options to start specific Director Console containers:

• dc-db: Starts the Director Console database container.

• dc-back: Starts the Director Console backend container.

• dc-front: Starts the Director Console frontend container.

Syntax:

start-dc-service <service name>(Optional)

Options:

Example:

To start all Director Console containers:

start-dc-service

To start the Director Console database container:

start-dc-service dc-db

stop-dc-service¶

Execute the stop-dc-service command to stop the containers inside Director Console. You can execute the command with the following options to stop specific Director Console containers:

• dc-db: Stops the Director Console database container.

• dc-back: Stops the Director Console backend container.

• dc-front: Stops the Director Console frontend container.

Syntax:

stop-dc-service <service name>(Optional)

Options:

Example:

To stop all Director Console containers:

stop-dc-service

To stop the Director Console database container:

stop-dc-service dc-db

install-dc¶

Execute the install-dc command to install Director Console.

Example:

install-dc

upload-dc-backup¶

Execute the upload-dc-backup command to copy the backup of Director Console.

Example:

upload-dc-backup

change-fabric-authpwd¶

Execute the change-fabric-authpwd command to change the Fabric Authenticator password. This command updates the Fabric Authenticator password in the API Server and the Fabric Server.

Example:

change-fabric-authpwd

change-fabric-proxyacl¶

Execute the change-fabric-proxyacl command to change the Fabric Proxy ACL (Access Control List). You can also use this command to change the Fabric Proxy’s authentication credentials.

Example:

change-fabric-proxyacl

get-fabrichosts¶

Execute the get-fabrichosts command to pull the host files from the Fabric Server to the API Server.

Example:

get-fabrichosts

com-appinstaller¶

​ Execute the com-appinstaller command to update the physical and tunnel IP address of Fabric Server in the API Server.

Example:

com-appinstaller

addldapsrv¶

​​ Execute the addldapsrv command to connect to a remote LDAP server.

Example:

addldapsrv

removeldapsrv¶

​​​ Execute the removeldapsrv command to remove the existing LDAP server access.

Example:

removeldapsrv

db-backup¶

​​​​ Execute the db-backup command to create a backup of the Director Console database. Go to the Director Console Backup and Restore section for details.

Example:

db-backup

db-restore¶

​​​​​ Execute the db-restore command to restore a backup of the Director Console database. Go to the Director Console Backup and Restore section for details.

Example:

db-restore

sftp-configure¶

​​​​​​ Execute the sftp-configure command to configure a remote SFTP server. Go to the Director Console Backup and Restore section for details.

Example:

sftp-configure

docker¶

Execute the docker command to manage docker services.

Example:

docker